// Copyright 2019 Istio Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package framework

import (
	"istio.io/istio/pkg/test/framework/components/environment"
)

// RequireEnvironment will mark the suite as skipped if the expected environment is not found.
func RequireEnvironment(n environment.Name) SetupFn { // nolint:interfacer
	return func(ctx SuiteContext) error {
		if ctx.Environment().EnvironmentName() != n {
			ctx.Skipf("RequireEnvironment (%s): Test suite does not support environment: %q",
				n.String(), ctx.Environment().EnvironmentName())
		}
		return nil
	}
}
